// Copyright (C) Kumo inc. and its affiliates.
// Author: Jeff.li lijippy@163.com
// All rights reserved.
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
#pragma once

#include <pollux/type/type.h>

namespace kumo::pollux {
    /// Return the approximate encoding width of the given type. The width of a type
    /// is the number of streams involved when reading or writing data of this type.
    ///
    /// NOTE: this is an approximate encoding width for a given data type with
    /// direct file encoding or flat in-memory encoding. But for dictionary or
    /// flatmap encoding, there might be more streams encoded. Also this doesn't
    /// count the encoded null stream.
    size_t approximate_type_encoding_width(const TypePtr &type);
} // namespace kumo::pollux
